Vcenter Vm Hardware Boot CreateSpec

The Vcenter Vm Hardware Boot CreateSpec schema describes settings used when booting a virtual machine.

JSON Example

{
    "type": "string",
    "efi_legacy_boot": false,
    "network_protocol": "string",
    "delay": 0,
    "retry": false,
    "retry_delay": 0,
    "enter_setup_mode": false
}

string

type

Optional

Firmware type to be used by the virtual machine.

For more information see: Vcenter Vm Hardware Boot Type.

If missing or null, defaults to value that is recommended for the guest OS and is supported for the virtual hardware version.

boolean

efi_legacy_boot

Optional

Flag indicating whether to use EFI legacy boot mode.

If missing or null, defaults to value that is recommended for the guest OS and is supported for the virtual hardware version.

string

network_protocol

Optional

Protocol to use when attempting to boot the virtual machine over the network.

For more information see: Vcenter Vm Hardware Boot NetworkProtocol.

If missing or null, defaults to a system defined default value.

integer As int64 As int64

delay

Optional

Delay in milliseconds before beginning the firmware boot process when the virtual machine is powered on. This delay may be used to provide a time window for users to connect to the virtual machine console and enter BIOS setup mode.

If missing or null, default value is 0.

boolean

retry

Optional

Flag indicating whether the virtual machine should automatically retry the boot process after a failure.

If missing or null, default value is false.

integer As int64 As int64

retry_delay

Optional

Delay in milliseconds before retrying the boot process after a failure; applicable only when Vcenter Vm Hardware Boot Info.retry is true.

If missing or null, default value is 10000.

boolean

enter_setup_mode

Optional

Flag indicating whether the firmware boot process should automatically enter setup mode the next time the virtual machine boots. Note that this flag will automatically be reset to false once the virtual machine enters setup mode.

If missing or null, the value is unchanged.